Represents an organisation, and allows access to information about members of that organisation You can get the OrgData for the organisation which owns the current website in templating with the orgData property of the WebsiteRootFolder eg $page.find("/").orgData You can also get the OrgData object for a user's membership And once you have an OrgData, if it contains child organisations then you can use the childOrgs and allSubOrgs methods on the OrgData object to get them
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| id | long | ||
| orgId | String | ||
| orgTypeName | String | ||
| orgTypeDisplayName | String | ||
| selectedOrgTypes | List | ||
| title | String | ||
| address | String | ||
| addressLine2 | String | ||
| addressState | String | ||
| phone | String | ||
| String | |||
| state | String | ||
| postcode | String | ||
| country | String | ||
| photoHash | String | ||
| lat | Double | ||
| lng | Double | ||
| timezone | String | ||
| formattedName | String | ||
| fields | Map | Get a map of fields, keyed on the field name and with the field value | |
| hasPrimaryMembers | boolean | If this organisation has at least one primary memberships | |
| parent | OrgData | Returns the parent organisation of this organisation, unless this organisation is the owner of the current website, in which case it returns null |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| members ( groupName ) | MembershipList | Get a list of MembershipBean of the given group | |
| primaryMembers ( ) | MembershipList | Get all primary MembershipBean's of this organisation | |
| childOrgs ( ) | OrgDataList | Returns only direct child organisations, ie organisations where the parent is this organisation | |
| findChildOrgByField ( fieldName, value ) | OrgData | Find a child org with a matching custom field | |
| childOrg ( orgId ) | OrgData | ||
| childOrg ( orgId ) | OrgData | ||
| allSubOrgs ( orgType ) | OrgDataList | Returns all subordinate organisations, ie child organisations and their child orgs, and so | |
| findProfile ( emailOrName ) | ExtProfileBean | ||
| findMembershipByField ( groupName, fieldName, value, contains ) | MembershipBean | This will only locate members directly connected to this organisation | |
| findChildMembershipByField ( groupName, fieldName, ovalue, contains ) | MembershipBean | Locate any membership inside this root organisation with the given field name and value for the given group | |
| hasMembership ( userId, groupName ) | boolean | Checks if a user has a membership to a group | |
| createMembership ( userId, email, orgId, groupName ) | MembershipBean | Creates a new membership, or returns an existing one, for a profile. Will create the profile if it does not exist. | |
| updateMembership ( profile, groupName, withinOrg, fieldValues ) | void | ||
| createMembership ( userId, email, orgDataToJoin, groupName ) | MembershipBean | ||
| getOrCreateChildOrg ( newOrgId, orgTitle, orgType ) | OrgData | Create a new child organisation or return one if it already exists, by looking up the orgID | |
| updateOrg ( parameters ) | JsonResult | Update organisation info e.g. lat/lng, address, etc | |
| createGroup ( name, title, groupType, regoMode ) | Group | ||
| createGroup ( name ) | Group |
Hide comments
